/*
 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Git Development Community nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System.Collections.Generic;

namespace GitSharp.Core.Transport
{
    /// <summary>
    /// Base helper class for fetch connection implementations. Provides some common
    /// typical structures and methods used during fetch connection.
    /// <para/>
    /// Implementors of fetch over pack-based protocols should consider using
    /// <see cref="BasePackFetchConnection"/> instead.
    /// </summary>
    public abstract class BaseFetchConnection : BaseConnection, IFetchConnection
    {
        public void Fetch(ProgressMonitor monitor, ICollection<Ref> want, IList<ObjectId> have)
        {
            markStartedOperation();
            doFetch(monitor, want, have);
        }
        /// <summary>
        /// Default implementation of <see cref="IFetchConnection.DidFetchIncludeTags"/> -
        /// returning false.
        /// </summary>
        public bool DidFetchIncludeTags
        {
            get
            {
                return false;
            }
        }

        public abstract bool DidFetchTestConnectivity { get; }
        public abstract List<PackLock> PackLocks { get; }
        public abstract void SetPackLockMessage(string message);

        /// <summary>
        /// Implementation of <see cref="Fetch"/>
        /// without checking for multiple fetch.
        /// </summary>
        /// <param name="monitor">as in <see cref="Fetch"/></param>
        /// <param name="want">as in <see cref="Fetch"/></param>
        /// <param name="have">as in <see cref="Fetch"/></param>
        protected abstract void doFetch(ProgressMonitor monitor, ICollection<Ref> want, IList<ObjectId> have);
    }

}